add wait_for_modify_volume_complete option #1558

mschurenko · 2023-05-19T01:23:58Z

SUMMARY

ISSUE TYPE

Feature Pull Request

COMPONENT NAME

ec2_vol

ADDITIONAL INFORMATION

I ran into the following issue when trying to modify an unattached volume:

boto3_version: 1.26.122
  botocore_version: 1.29.122
  error:
    code: OperationNotPermitted
    message: 'Cannot attach volume vol-02f06b9e2f1e6d1e0 when it is in modification state: MODIFYING'
  msg: 'Error while attaching EBS volume: An error occurred (OperationNotPermitted) when calling the AttachVolume operation: Cannot attach volume vol-02f06b9e2f1e6d1e0 when it is in modification state: MODIFYING'

There seems to be no waiter, but if we poll describe_volumes_modifications we can wait until ModificationState is complete.

softwarefactory-project-zuul · 2023-05-19T03:41:03Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/22d983eab41546ddbe025192da27cc59

✔️ ansible-galaxy-importer SUCCESS in 3m 44s
✔️ build-ansible-collection SUCCESS in 14m 11s
✔️ ansible-test-splitter SUCCESS in 4m 53s
✔️ integration-amazon.aws-1 SUCCESS in 14m 46s
Skipped 43 jobs

mschurenko · 2023-06-06T19:06:51Z

Hi. Just bumping in case this wasn't noticed.

ansibullbot · 2023-07-12T17:46:29Z

cc @jillr @lwade @s-hertel @tremble
click here for bot help

hakbailey

Thanks for submitting this PR! Could you add the new option to the documentation block?

plugins/modules/ec2_vol.py

github-actions · 2023-07-24T18:59:24Z

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run:
https://github.com/ansible-collections/amazon.aws/actions/runs/5732736742

You can compare to the docs for the main branch here:
https://ansible-collections.github.io/amazon.aws/branch/main

File changes:

M collections/amazon/aws/ec2_vol_module.html

Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_vol_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_vol_module.html
index 96ff50b..f06554e 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/ec2_vol_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/ec2_vol_module.html
@@ -502,6 +502,28 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-ec2-vol-
 </div></td>
 </tr>
 <tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-wait"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-ec2-vol-module-parameter-wait"><strong>wait</strong></p>
+<a class="ansibleOptionLink" href="#parameter-wait" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
+<p><span class="ansible-option-versionadded">added in amazon.aws 6.3.0</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>Wait for volume modification to complete.</p>
+<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
+<ul class="simple">
+<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-wait_timeout"></div><p class="ansible-option-title" id="ansible-collections-amazon-aws-ec2-vol-module-parameter-wait-timeout"><strong>wait_timeout</strong></p>
+<a class="ansibleOptionLink" href="#parameter-wait_timeout" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
+<p><span class="ansible-option-versionadded">added in amazon.aws 6.3.0</span></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>How long before wait gives up, in seconds.</p>
+<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">900</span></code></p>
+</div></td>
+</tr>
+<tr class="row-even"><td><div class="ansible-option-cell">
 <div class="ansibleOptionAnchor" id="parameter-zone"></div>
 <div class="ansibleOptionAnchor" id="parameter-availability_zone"></div>
 <div class="ansibleOptionAnchor" id="parameter-aws_zone"></div>

ansibullbot · 2023-07-24T19:03:14Z

@mschurenko this PR contains the following merge commits:

c0764af

Please rebase your branch to remove these commits.

click here for bot help

softwarefactory-project-zuul · 2023-07-24T19:44:32Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/fa31e40ffa3a4f20a9121b53aee3f058

✔️ ansible-galaxy-importer SUCCESS in 3m 53s
✔️ build-ansible-collection SUCCESS in 13m 36s
✔️ ansible-test-splitter SUCCESS in 5m 15s
✔️ integration-amazon.aws-1 SUCCESS in 12m 49s
Skipped 43 jobs

hakbailey

Whoops, just noticed there isn't a changelog fragment for this, could you add that too? Thanks!

mschurenko · 2023-07-25T19:21:56Z

Whoops, just noticed there isn't a changelog fragment for this, could you add that too? Thanks!

So should I add something to CHANGELOG.rst?

Sorry, I see it's documented here https://docs.ansible.com/ansible/latest/community/collection_development_process.html#creating-a-changelog-fragment

mschurenko · 2023-07-25T19:40:27Z

Whoops, just noticed there isn't a changelog fragment for this, could you add that too? Thanks!

So should I add something to CHANGELOG.rst?

Sorry, I see it's documented here https://docs.ansible.com/ansible/latest/community/collection_development_process.html#creating-a-changelog-fragment

Ok I think (hope) I did it correctly.

softwarefactory-project-zuul · 2023-07-25T20:06:43Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/db0933b73703460ca5575c23fff56dd0

✔️ ansible-galaxy-importer SUCCESS in 10m 30s
✔️ build-ansible-collection SUCCESS in 12m 54s
✔️ ansible-test-splitter SUCCESS in 6m 02s
✔️ integration-amazon.aws-1 SUCCESS in 13m 17s
Skipped 43 jobs

softwarefactory-project-zuul · 2023-07-25T21:12:25Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/bb49ffb2e5294d02b256e3671ce7fa02

✔️ ansible-galaxy-importer SUCCESS in 5m 15s
✔️ build-ansible-collection SUCCESS in 13m 32s
✔️ ansible-test-splitter SUCCESS in 5m 27s
✔️ integration-amazon.aws-1 SUCCESS in 13m 53s
Skipped 43 jobs

plugins/modules/ec2_vol.py

softwarefactory-project-zuul · 2023-08-01T19:48:58Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/0d028cf058964cae9be01796aab22663

✔️ ansible-galaxy-importer SUCCESS in 3m 44s
✔️ build-ansible-collection SUCCESS in 13m 25s
✔️ ansible-test-splitter SUCCESS in 4m 43s
❌ integration-amazon.aws-1 FAILURE in 25m 54s
Skipped 43 jobs

ansibullbot · 2023-08-01T21:19:33Z

@mschurenko this PR contains the following merge commits:

d7574b8

Please rebase your branch to remove these commits.

click here for bot help

softwarefactory-project-zuul · 2023-08-02T00:04:02Z

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/303df7e6e286475a89651fe19a8bd37d

✔️ ansible-galaxy-importer SUCCESS in 4m 52s
✔️ build-ansible-collection SUCCESS in 14m 42s
✔️ ansible-test-splitter SUCCESS in 5m 33s
❌ integration-amazon.aws-1 FAILURE in 39m 18s
Skipped 43 jobs

hakbailey · 2023-08-22T23:53:15Z

recheck

softwarefactory-project-zuul · 2023-08-23T00:28:13Z

Build succeeded.
https://ansible.softwarefactory-project.io/zuul/buildset/d66b52319e6045c99581d1eb5f688c99

✔️ ansible-galaxy-importer SUCCESS in 4m 52s
✔️ build-ansible-collection SUCCESS in 12m 35s
✔️ ansible-test-splitter SUCCESS in 5m 04s
✔️ integration-amazon.aws-1 SUCCESS in 18m 20s
Skipped 43 jobs

alinabuzachis · 2023-08-23T10:44:38Z

plugins/modules/ec2_vol.py

+                mod_state = ""
+                _wait_till = module.params.get("wait_timeout") + time.time()
+                while _wait_till > time.time():
+                    mod_response = ec2_conn.describe_volumes_modifications(VolumeIds=[volume["volume_id"]])


One small thing. I guess we should enclose mod_response = ec2_conn.describe_volumes_modifications(VolumeIds=[volume["volume_id"]]) in a try-except block.

Ok, I can add that

alinabuzachis · 2023-08-23T10:49:01Z

plugins/modules/ec2_vol.py

@@ -769,6 +805,9 @@ def main():
    if multi_attach is True and volume_type not in ("io1", "io2"):
        module.fail_json(msg="multi_attach is only supported for io1 and io2 volumes.")

+    if wait is True and modify_volume is False:
+        module.fail_json(msg="wait does nothing if modify_volume is False.")


I guess it should work for now. We would probably also like to add the option to wait for deletion in the future.

We are using this module currently and have decided to wait for either completed or optimizing as waiting for completed can take a very long time. Should we do the same here? Or should we have the option to wait for one or more modification states?

How about having an option like this?

wait_modification_states: description: - A list of modification states to wait for. Valid options are "completed" and "optimizing" type: list default: ["completed", "optimizing"]

gravesm added the needs_triage label Jun 7, 2023

ansibullbot added community_review feature This issue/PR relates to a feature request module module new_contributor Help guide this first time contributor plugins plugin (any type) labels Jul 12, 2023

hakbailey requested changes Jul 24, 2023

View reviewed changes

plugins/modules/ec2_vol.py Outdated Show resolved Hide resolved

ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html and removed community_review labels Jul 24, 2023

mschurenko force-pushed the add-wait-for-modify-complete branch from c0764af to 3b68a5c Compare July 24, 2023 19:16

ansibullbot added community_review and removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Jul 24, 2023

hakbailey approved these changes Jul 25, 2023

View reviewed changes

hakbailey requested changes Jul 25, 2023

View reviewed changes

jillr removed the needs_triage label Jul 25, 2023

alinabuzachis requested changes Aug 1, 2023

View reviewed changes

plugins/modules/ec2_vol.py Outdated Show resolved Hide resolved

ansibullbot added merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html and removed community_review labels Aug 1, 2023

mschurenko added 6 commits August 1, 2023 15:55

add wait_for_modify_volume_complete option

e6767df

increasing polling interval;adding doc;check for failed

7bb7ac8

adding changelog fragment

6d28b3c

fix linting

d48dcf9

fix sanity test

30bd554

updating params

d0be10e

mschurenko force-pushed the add-wait-for-modify-complete branch from d7574b8 to d0be10e Compare August 1, 2023 23:09

ansibullbot added community_review and removed merge_commit This PR contains at least one merge commit. Please resolve! needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Aug 1, 2023

alinabuzachis requested a review from tremble August 2, 2023 11:52

alinabuzachis added this to the 6.4.0 milestone Aug 4, 2023

alinabuzachis reviewed Aug 23, 2023

View reviewed changes

hakbailey added the waiting_on_contributor Needs help. Feel free to engage to get things unblocked label Sep 1, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add wait_for_modify_volume_complete option #1558

add wait_for_modify_volume_complete option #1558

mschurenko commented May 19, 2023 •

edited

Loading

softwarefactory-project-zuul bot commented May 19, 2023

mschurenko commented Jun 6, 2023

ansibullbot commented Jul 12, 2023

hakbailey left a comment

github-actions bot commented Jul 24, 2023 •

edited

Loading

ansibullbot commented Jul 24, 2023

softwarefactory-project-zuul bot commented Jul 24, 2023

hakbailey left a comment

mschurenko commented Jul 25, 2023 •

edited

Loading

mschurenko commented Jul 25, 2023

softwarefactory-project-zuul bot commented Jul 25, 2023

softwarefactory-project-zuul bot commented Jul 25, 2023

softwarefactory-project-zuul bot commented Aug 1, 2023

ansibullbot commented Aug 1, 2023

softwarefactory-project-zuul bot commented Aug 2, 2023

hakbailey commented Aug 22, 2023

softwarefactory-project-zuul bot commented Aug 23, 2023

alinabuzachis Aug 23, 2023

mschurenko Aug 26, 2023

alinabuzachis Aug 23, 2023

mschurenko Aug 26, 2023

add wait_for_modify_volume_complete option #1558

Are you sure you want to change the base?

add wait_for_modify_volume_complete option #1558

Conversation

mschurenko commented May 19, 2023 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

ADDITIONAL INFORMATION

softwarefactory-project-zuul bot commented May 19, 2023

mschurenko commented Jun 6, 2023

ansibullbot commented Jul 12, 2023

hakbailey left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 24, 2023 • edited Loading

Docs Build 📝

ansibullbot commented Jul 24, 2023

softwarefactory-project-zuul bot commented Jul 24, 2023

hakbailey left a comment

Choose a reason for hiding this comment

mschurenko commented Jul 25, 2023 • edited Loading

mschurenko commented Jul 25, 2023

softwarefactory-project-zuul bot commented Jul 25, 2023

softwarefactory-project-zuul bot commented Jul 25, 2023

softwarefactory-project-zuul bot commented Aug 1, 2023

ansibullbot commented Aug 1, 2023

softwarefactory-project-zuul bot commented Aug 2, 2023

hakbailey commented Aug 22, 2023

softwarefactory-project-zuul bot commented Aug 23, 2023

alinabuzachis Aug 23, 2023

Choose a reason for hiding this comment

mschurenko Aug 26, 2023

Choose a reason for hiding this comment

alinabuzachis Aug 23, 2023

Choose a reason for hiding this comment

mschurenko Aug 26, 2023

Choose a reason for hiding this comment

mschurenko commented May 19, 2023 •

edited

Loading

github-actions bot commented Jul 24, 2023 •

edited

Loading

mschurenko commented Jul 25, 2023 •

edited

Loading